home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / XmProcessTraversal.z / XmProcessTraversal
Encoding:
Text File  |  2003-11-18  |  6.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmPPPPrrrroooocccceeeessssssssTTTTrrrraaaavvvveeeerrrrssssaaaallll((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPrrrroooocccceeeessssssssTTTTrrrraaaavvvveeeerrrrssssaaaallll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _X_m_P_r_o_c_e_s_s_T_r_a_v_e_r_s_a_l - A function that determines which
  10.       component receives keyboard events when a widget has the
  11.       focus
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.       #include <Xm/Xm.h>
  15.  
  16.       Boolean XmProcessTraversal (wwwwiiiiddddggggeeeetttt,,,, ddddiiiirrrreeeeccccttttiiiioooonnnn)
  17.            _W_i_d_g_e_t          wwwwiiiiddddggggeeeetttt;
  18.            _X_m_T_r_a_v_e_r_s_a_l_D_i_r_e_c_t_i_o_nddddiiiirrrreeeeccccttttiiiioooonnnn;
  19.  
  20.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.       _X_m_P_r_o_c_e_s_s_T_r_a_v_e_r_s_a_l determines    which component    of a hierarchy
  22.       receives keyboard events when    the hierarchy that contains
  23.       the given widget has keyboard    focus.    Using
  24.       _X_m_P_r_o_c_e_s_s_T_r_a_v_e_r_s_a_l to    traverse to MenuBars, Pulldown
  25.       MenuPanes, or    Popup MenuPanes    is not supported.
  26.  
  27.       wwwwiiiiddddggggeeeetttt
  28.            Specifies the widget ID of the widget whose hierarchy
  29.            is to be    traversed.  The    hierarchy is only traversed up
  30.            to the top of the shell.     If that shell does not
  31.            currently have the focus, any changes to    the element
  32.            with focus within that shell will not occur until the
  33.            next time the shell recieves focus.
  34.  
  35.       ddddiiiirrrreeeeccccttttiiiioooonnnn
  36.            Specifies the direction of traversal
  37.  
  38.       The ddddiiiirrrreeeeccccttttiiiioooonnnn    parameter can have the following values, which
  39.       cause    the routine to take the    corresponding actions:
  40.  
  41.       +o    _X_m_T_R_A_V_E_R_S_E__C_U_R_R_E_N_T - Finds the hierarchy    and the    tab
  42.            group that contain wwwwiiiiddddggggeeeetttt.  If this tab group is    not
  43.            the active tab group, makes it the active tab group.
  44.            If wwwwiiiiddddggggeeeetttt is an item in the active tab group, makes it
  45.            the active item.     If wwwwiiiiddddggggeeeetttt is the active tab group,
  46.            makes the first traversable item    in the tab group the
  47.            active item.
  48.  
  49.       +o    _X_m_T_R_A_V_E_R_S_E__D_O_W_N - Finds the hierarchy that contains
  50.            wwwwiiiiddddggggeeeetttt.    Finds the active item in the active tab    group
  51.            and makes the item below    it the active item.  If    there
  52.            is no item below, wraps.
  53.  
  54.       +o    _X_m_T_R_A_V_E_R_S_E__H_O_M_E - Finds the hierarchy that contains
  55.            wwwwiiiiddddggggeeeetttt.    Finds the active item in the active tab    group
  56.            and makes the first traversable item in the tab group
  57.            the active item.
  58.  
  59.       +o    _X_m_T_R_A_V_E_R_S_E__L_E_F_T - Finds the hierarchy that contains
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmPPPPrrrroooocccceeeessssssssTTTTrrrraaaavvvveeeerrrrssssaaaallll((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmPPPPrrrroooocccceeeessssssssTTTTrrrraaaavvvveeeerrrrssssaaaallll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.            wwwwiiiiddddggggeeeetttt.    Finds the active item in the active tab    group
  75.            and makes the item to the left the active item.    If
  76.            there is    no item    to the left, wraps.
  77.  
  78.       +o    _X_m_T_R_A_V_E_R_S_E__N_E_X_T - Finds the hierarchy that contains
  79.            wwwwiiiiddddggggeeeetttt.    Finds the active item in the active tab    group
  80.            and makes the next item in child    order the active item.
  81.  
  82.       +o    _X_m_T_R_A_V_E_R_S_E__N_E_X_T__T_A_B__G_R_O_U_P - Finds the hierarchy that
  83.            contains    wwwwiiiiddddggggeeeetttt.     Finds the active tab group (if    any)
  84.            and makes the next tab group the    active tab group in
  85.            the hierarchy.
  86.  
  87.       +o    _X_m_T_R_A_V_E_R_S_E__P_R_E_V - Finds the hierarchy that contains
  88.            wwwwiiiiddddggggeeeetttt.    Finds the active item in the active tab    group
  89.            and makes the previous item in child order the active
  90.            item.
  91.  
  92.       +o    _X_m_T_R_A_V_E_R_S_E__P_R_E_V__T_A_B__G_R_O_U_P - Finds the hierarchy that
  93.            contains    wwwwiiiiddddggggeeeetttt.     Finds the active tab group (if    any)
  94.            and makes the previous tab group    the active tab group
  95.            in the hierarchy.
  96.  
  97.       +o    _X_m_T_R_A_V_E_R_S_E__R_I_G_H_T    - Finds    the hierarchy that contains
  98.            wwwwiiiiddddggggeeeetttt. Finds the active    item in    the active tab group
  99.            and makes the item to the right the active item.     If
  100.            there is    no item    to the right, wraps.
  101.  
  102.       +o    _X_m_T_R_A_V_E_R_S_E__U_P - Finds the hierarchy that    contains
  103.            wwwwiiiiddddggggeeeetttt.    Finds the active item in the active tab    group
  104.            and makes the item above    it the active item.  If    there
  105.            is no item above, wraps.
  106.  
  107.     CCCCAAAAUUUUTTTTIIIIOOOONNNNSSSS
  108.       +o    _X_m_P_r_o_c_e_s_s_T_r_a_v_e_r_s_a_l will not allow traversal to a    widget
  109.            in a different shell.
  110.  
  111.       +o    _X_m_P_r_o_c_e_s_s_T_r_a_v_e_r_s_a_l will only allow traversal to widgets
  112.            that are    currently mapped.
  113.  
  114.       +o    You cannot call _X_m_P_r_o_c_e_s_s_T_r_a_v_e_r_s_a_l from inside a
  115.            focusCallback routine (or you will get a    segmentation
  116.            fault).
  117.  
  118.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  119.       Returns True if the setting succeeded.  Returns False    if the
  120.       keyboard focus policy    is not _X_m_E_X_P_L_I_C_I_T, if there are    no
  121.       traversable items, or    if the call to the routine has invalid
  122.       parameters.
  123.  
  124.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  125.       _X_m_G_e_t_V_i_s_i_b_i_l_i_t_y(_3_X) and _X_m_I_s_T_r_a_v_e_r_s_a_b_l_e(_3_X).
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.